PATHMac OS 8 Developer Documentation > Networking and Communications > AppleShare >

User Authentication Modules

UAMCall Routine

Send a command to a server UAM.



 
pascal OSErr UAMCall(UAMArgs *);

UAMArgs: A UAMArgs structure whose fields define the command type and provide the information required to complete the call successfully.

If a fatal error occurs for which a client UAM puts up a dialog box, the client UAM should return userCancelledErr to back out of the UAM call.

DISCUSSION

If you are implementing a client UAM, you must implement a UAMCall routine. The AFP client must call UAMCall from it's main event loop so the client UAM can make A5-dependent calls, such as calls to QuickDraw and the Resource Manager.

shows the typical sequence of commands for three scenarios:

Table 3-1 Typcial client UAM command sequence

Chooser login	Chooser already connected	Alias resolution1
1. `UAMOpen`	1. `UAMOpen`	1. `UAMOpen`
1a. `UAMPWDlog` 2	1a. `UAMChgPassDlg` 2	1a. `UAMPWDlog2`
2. `UAMLogin`	1b. `UAMChgPass` 2	2. `UAMLogin`
2a. `UAMChgPassDlg` 2	1c. `UAMVSDlog` 2	2a. `UAMChgPassDlg` 2
2b. `UAMChgPass` 2	1d. `UAMGetInfoSize` 2	2b. `UAMChgPass` 2
2c. `UAMVSDlog` 2	1e. `UAMGetInfo` 2	2c. `UAMGetInfoSize` 2
2d. `UAMGetInfoSize` 2	2. `UAMClose`	2d. `UAMGetInfo` 2
2e. `UAMGetInfo` 2		3. `UAMClose`
3. `UAMClose`
1 This sequence is typical of any program that calls `PBVolumeMount` specifying the protocol name of the UAM as a parameter. 2Optional commands.

As noted in , some client UAM commands are optional. The value returned to the AFP client by your UAM's UAMOpen entry point indicates the optional commands that your UAM supports and determines whether the AFP client will call any optional commands supported by your UAM. The mechanism for indicating support for optional commands is described in the section UAMOpen Command .